home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / bbs / raptr9b4.zip / RAPDOCS.ZIP / MENU.DOC < prev    next >
Text File  |  1995-06-15  |  36KB  |  1,409 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.        ------------------------------------------------------------------
  29.       ---/    RAPTOR  Bulletin Board System -- Version .01 Alpha      \---
  30.      ---( Copyright 1995 by LAIRWare and the RAPTOR Development Team  )---
  31.       ---\                 - All Rights Reserved-                    /---
  32.        ------------------------------------------------------------------
  33.  
  34.                            Menu Command Documentation
  35.                                January 30, 1995
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.             RAPTOR  Bulletin Board System Menu Command Documentation
  54.            Copyright 1995 by LAIRWare and the RAPTOR Development Team
  55.                               All rights reserved.
  56.  
  57.      No  part  of  this publication may be  reproduced  without  the  prior
  58.      written consent of the copyright holders.  All brand and product names
  59.      mentioned in this publication are trademarks or registered  trademarks
  60.      of their respective copyright holders.
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.                       ___________________________________
  72.  
  73.                        T A B L E   O F   C O N T E N T S
  74.                       ___________________________________
  75.  
  76.  
  77.      Introduction ..................................................... 1
  78.      "-" - File/Menu Commands ......................................... 2
  79.      "A" - Archive Manipulation Commands .............................. 5
  80.      "B" - Batch File Transfer Commands ............................... 6
  81.      "D" - Door Commands .............................................. 7
  82.      "F" - File System Commands ....................................... 9
  83.      "H" - Hangup Commands ............................................ 12
  84.      "M" - Message System Commands .................................... 13
  85.      "O" - Miscellaneous Commands ..................................... 15
  86.      "U" - AutoMessage Commands ....................................... 18
  87.      "*" - SysOp Commands ............................................. 19
  88.  
  89.                 RAPTOR  Menu Command Documentation - Version 2.5
  90.  
  91.  
  92.                                  ______________
  93.  
  94.                                   INTRODUCTION
  95.                                  ______________
  96.  
  97.  
  98.      On the next few pages are described all the actual commands  available
  99.      for use in  RAPTOR  menus.  They are broken up into several  sections:
  100.      File/menu  related,  archive  manipulation  related,  batch   transfer
  101.      related,  door related, file system related, hangup  related,  message
  102.      related,  other functions (main menu, etc.), automessage  related  and
  103.      SysOp related.
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.                                    - Page 1 -
  151.  
  152.                 RAPTOR  Menu Command Documentation - Version 2.5
  153.  
  154.  
  155.                            __________________________
  156.  
  157.                             "-" - FILE/MENU COMMANDS
  158.                            __________________________
  159.  
  160.  
  161.      Cmdkeys : "-C"
  162.      Function: Display message on commandline (use with linking)
  163.      MString : <string>
  164.  
  165.      Cmdkeys : "-F"
  166.      Function: Display a text file
  167.      MString : [<path>] <filename> [.<ext>]
  168.  
  169.                     [<path>]       Optional directory location of file.
  170.                     <filename>     An 8-character MS-DOS filename.
  171.                     [.<ext>]       Optional MS-DOS extension, if not ".MSG"
  172.                                    and/or ".ANS".
  173.  
  174.                This command will display a text file.  If no <path> is
  175.                given, the file is assumed to be located in the AFILES
  176.                directory.  If no .<ext> is given,  RAPTOR  will look for
  177.                the standard "*.MSG" and/or "*.ANS" extensions.  That is, if
  178.                the "*.ANS" version exists and the user's ANSI is enabled,
  179.                it will be displayed, otherwise the "*.MSG" is displayed.
  180.  
  181.      Cmdkeys : "-H"
  182.      Function: Menu key help (use for ?:Help command)
  183.      MString : None
  184.  
  185.                Not really required any more.   RAPTOR  will automatically
  186.                display the current menu's help file (or the generic short
  187.                or long menu) from ANY menu if the user enters a "?".
  188.  
  189.      Cmdkeys : "-L"
  190.      Function: Display a line of text
  191.      MString : <string>
  192.  
  193.      Cmdkeys : "-Q"
  194.      Function: Read an InfoForm questionaire file (answers in .ASW)
  195.      MString : <InfoForm questionaire filename>
  196.  
  197.      Cmdkeys : "-R"
  198.      Function: Read an InfoForm questionaire answer file
  199.      MString : <InfoForm questionaire filename>
  200.  
  201.                If the MString is "", the filename is prompted for.
  202.  
  203.      Cmdkeys : "-S"
  204.      Function: Append line to sysop log file (SYSOP.LOG) (use with linking)
  205.      MString : <string>
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.                                    - Page 2 -
  214.  
  215.                 RAPTOR  Menu Command Documentation - Version 2.5
  216.  
  217.  
  218.      Cmdkeys : "-;"
  219.      Function: Execute macro
  220.      MString : <macro>
  221.  
  222.                This command will enter <macro> into the user's macro
  223.                buffer, and the macro will be executed in the same manner as
  224.                that of a user-defined macro.  All occurances of ";" in the
  225.                <macro> string are substituted with <CR>s.  Many different
  226.                things are possible with this command.
  227.  
  228.      Cmdkeys : "-$"
  229.      Function: Prompt for password
  230.      MString : <password> [ [;<prompt>] ;<bad-message>]
  231.  
  232.                This command first will display <prompt>, if it exists.  If
  233.                not, a default ":" prompt will be displayed.  If the
  234.                password is entered incorrectly, <bad-message> will be
  235.                displayed, if it exists, and all further linking will be
  236.                terminated.  This can be used for special passwords for
  237.                remote shelling to DOS, etc.
  238.  
  239.      Cmdkeys : "-^"
  240.      Function: Goto menu
  241.      MString : <menu file> [ [;C] ;<link command>]
  242.  
  243.                Loads in <menu file> (automatic assumed extension of
  244.                ".MNU").  If ";C" is specified, the Menu Stack is cleared
  245.                BEFORE going to the new menu.
  246.  
  247.                If <link command> is specified, the command with command
  248.                letters of <link command> will be executed after the new
  249.                menu is loaded.  Example: "-^", "msg;C;M" will clear the
  250.                Menu Stack, load MSG.MNU, and execute command "M" (Read
  251.                Mail).
  252.  
  253.      Cmdkeys : "-/"
  254.      Function: Gosub menu
  255.      MString : <menu file> [ [;C] [;<link command>] ]
  256.  
  257.                Adds the CURRENT menu to the Menu Stack, and loads in <menu
  258.                file> (automatic assumed extension of ".MNU").  If ";C" is
  259.                specified, the Menu Stack is cleared BEFORE going to the new
  260.                menu.
  261.  
  262.                If <link command> is specified, the command with command
  263.                letters of <link command> will be executed after the new
  264.                menu is loaded.  Example: "-/", "msg;;M" will save the
  265.                current menu file on the Menu Stack, load MSG.MNU, and
  266.                execute command "M" (Read Mail).
  267.  
  268.                See also Cmdkeys "-\" (Return from menu).
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.                                    - Page 3 -
  277.  
  278.                 RAPTOR  Menu Command Documentation - Version 2.5
  279.  
  280.  
  281.      Cmdkeys : "-\"
  282.      Function: Return from menu
  283.      MString : [ [C] [;<link command>] ]
  284.  
  285.                Loads in the last menu file in the Menu Stack.  If "C" is
  286.                specified, the Menu Stack is cleared BEFORE returning to the
  287.                old menu.
  288.  
  289.                If <link command> is specified, the command with command
  290.                letters of <link command> will be executed after the new
  291.                menu is loaded.  Example: "-\", "C;M" will clear the Menu
  292.                Stack, return to the previous menu, and execute command "M"
  293.                (Read Mail, if the menu returning to is "MSG.MNU").
  294.  
  295.                See also Cmdkeys "-/" (Gosub menu).
  296.  
  297.  
  298.  
  299.